Repository navigation
feat(changelog): Use GitHub alerts in changelog entries as release notes - #985
Merged
Merged
Conversation
A GitHub alert (> [!NOTE], > [!IMPORTANT], ...) in a PR's Changelog Entry section was dropped. It now goes as-is right under the version heading, above the categories, so it also reaches the GitHub release body and the changelog preview. Fixes #984 Co-Authored-By: BYK <126780+BYK@users.noreply.github.com>
Contributor
|
BYK
approved these changes
Nov 18, 2026
BYK
left a comment
Member
There was a problem hiding this comment.
LGTM
@lucas-zimerman - does this address your request?
8 tasks done
|
It does, thank you! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
With
changelog.policy: auto, a GitHub alert (> [!IMPORTANT]etc.) could not be placed at the top of a release section, because the "Changelog Entry" parser dropped blockquotes.A top-level GitHub alert in a PR's "Changelog Entry" section is now a release-level note. Craft puts it as-is right under the
## <version>heading, above the AI summary and the categories, so the GitHub release body (findChangeset) gets it too. The changelog preview shows it unquoted while the PR's own entry stays highlighted.becomes
Behavior details:
#skip-changelog, excluded author) and reverted PRs add no notes.The changelog docs gain a "Release Notes" item.
Fixes #984 (Option A)
via @BYK.
--
View Session [Sentry]